Quest API
Quest API
The Quest API allows authenticated users to access live quests associated with their connected game. It provides a streamlined way for partners to integrate quests, track user progress, and enable reward systems within their applications.
Table of Contents
Introduction
The Public Quest API is designed for developers who want to incorporate quest-based experiences into their games. This API provides endpoints to fetch active quests assigned to users, ensuring seamless tracking of in-game achievements and rewards.
It enables integration with game ecosystems, allowing real-time updates on quest progress, completion status, and claimable rewards.
Authentication
All requests to the Public Quest API require authentication using OAuth. The Authorization
header must include a valid OAuth Bearer token obtained through the login process.
Example Authorization Header:
Authorization: Bearer {your-oauth-token}
Error Handling
The API returns standard HTTP status codes, ensuring consistency in error responses.
- 401: Unauthorized - The request is missing a valid OAuth token or authentication has failed.
- 500: Internal Server Error - An unexpected error occurred on the server.
Example Application
The Maze Game fetches authenticated user quests using the Public Quest API. This allows Maze Game players to view their Tribally quests within the game interface!
Authentication
- HTTP: Bearer Auth
Security Scheme Type: | http |
---|---|
HTTP Authorization Scheme: | bearer |